How to connect to Kong

On this page you will learn how to connect your Kong Gateway to Boomi's API Control Plane.

Prerequisites

To proceed, you will need the following:

• A running instance of Boomi's API Control Plane.

• Access to the instance of your Kong Gateway (Open Source)

  • The Kong Gateway needs a database, otherwise neither applications nor subscriptions can be created.

• Docker to utilize the image of our agent, which acts as an intermediary.

Create a new Environment

To get started, open your API Control Plane instance and follow the instructions below.

Add an Environment

1. Navigate to Environments in the menu on the left side.

2. Click on the Register Environment button in the top right corner.

3. Select Kong.

4. Select Next.

Add Environment Information

1. Add the following information to the Environment Wizard:
   • Technical Name - The technical name of an API must be unique.
   • Display Name - The display name can differ from the technical name and does not have to be unique.
   • URL - The url of your MuleSoft proxy (e.g. http://my-mulesoft:8000). API urls are built by appending the path of the first route of a service (e.g. http://my-mulesoft:8000/petstore).
2. Confirm by clicking on the Register Environment button.

3. Click Next to start the Connection Wizard.

Provide the Gateway Information

The following describes how to create the gateway configuration for a Kong Gateway Agent.

Gateway Configuration

1. Add the URL to your Kong Management API.

   • If you are not sure whether you got the correct URL, you can try to access <URL>/services or <URL>/consumers. Both should return a valid response and no errors.

   • Your configuration file will download automatically.

2. Select Next.

Create an Agent as Intermediary

1. The following describes how to create a Docker container for the agent. It is described using a Docker compose file so that additional agents can be easily added to your docker stack later.

• image: The docker image of the API Control Plane Agent
• container_name: You can freely choose the name of your Agent here as well as in line 3.
• environment
  • backendUrl: The agent will establish a web-socket to this URL and thereby connect to your API Control Plane.
  • gateway-config: The path inside the container to the configuration you downloaded in step 2.
• volumes
  • The outer path of the configuration file : The inner path of the configuration file

2. Select Download and Next.

3. Put both files in the same folder. Then run the following commands.

docker pull apiida/controlplane-agent

4. Download the latest image of the agent:

   docker compose up

   • Starts the agent. It will connect automatically.

Check the Agent's Status

1. Open your API Control Plane instance.

2. Select Environments in the menu on the left side.

3. Your Agent should now be connected to API Control Plane.

• Click on the tile or the entry in the table to get more detailed information about the status of the connection. This can be very useful in case of an error.

You can now interact with your Gateways through Boomi's API Control Plane.

tip

It is easy to add more agents Repeat the steps here or that of another gateway and add the agents to the existing Docker compose file.